Inside Macintosh: Programming With the Text Encoding Conversion Manager /

Chapter 4 - Unicode Converter Reference / Unicode Converter Functions

Converting to Unicode /

DisposeTextToUnicodeInfo

Releases the memory allocated for the specified Unicode converter object.

pascal OSStatus DisposeTextToUnicodeInfo (
                     TextToUnicodeInfo *ioTextToUnicodeInfo);

ioTextToUnicodeInfo

A pointer to a Unicode converter object of type TextToUnicodeInfo (page 119), used for converting text to Unicode. On input, you specify the object to be disposed of, which your application created using the function CreateTextToUnicodeInfo (page 125) or CreateTextToUnicodeInfoByEncoding (page 127).

function result

A result code. See "Text Encoding Conversion Manager Result Codes" (page 42) in the chapter "Basic Text Types Reference."

DISCUSSION

The DisposeTextToUnicodeInfo function disposes of the Unicode converter object and releases the memory allocated for it. Your application should not attempt to dispose of the same structure more than once.

You use this function only to release the memory for objects that your application created through the function CreateTextToUnicodeInfo (page 125) or CreateTextToUnicodeInfoByEncoding (page 127). You must not use it for any other type of Unicode converter object.

If your application specifies an invalid Unicode converter object, such as NULL, the function returns a paramErr result code.